以分享为目的创建代码库

开发人员一旦写了些非常棒的Go代码,就会很想把这些代码与Go社区的其他人分享。这其实很容易,只需要执行下面的步骤就可以。

1.包应该在代码库的根目录中

使用 go get 的时候,开发人员指定了要导入包的全路径。这意味着在创建想要分享的代码库的时候,包名应该就是代码库的名字,而且包的源代码应该位于代码库目录结构的根目录。

Go语言新手常犯的一个错误是,在公用代码库里创建一个名为 code 或者 src 的目录。如果这么做,会让导入公用库的语句变得很长。为了避免过长的语句,只需要把包的源文件放在公用代码库的根目录就好。

2.包可以非常小

与其他语言相比,Go语言的包一般相对较小。不要在意包只支持几个API,或者只完成一项任务。在Go语言里,这样的包很常见,而且很受欢迎。

3.对代码执行 go fmt

和其他开源代码库一样,人们在试用代码前会通过源代码来判断代码的质量。开发人员需要在签入代码前执行 go fmt ,这样能让自己的代码可读性更好,而且不会由于一些字符的干扰(如制表符),在不同人的计算机上代码显示的效果不一样。

4.给代码写文档

Go开发者用 godoc 来阅读文档,并且会用http://godoc.org这个网站来阅读开源包的文档。如果按照 go doc 的最佳实践来给代码写文档,包的文档在本地和线上都会很好看,更容易被别人发现。

results matching ""

    No results matching ""